<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EOS.IO: contracts/eoslib/action.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EOS.IO
   &#160;<span id="projectnumber">DAWN3.0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ae9b15dd87e066e1908bbd90e8f38627.html">contracts</a></li><li class="navelem"><a class="el" href="dir_3fea0bf1ce879ce73e6ecec98007efcd.html">eoslib</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">action.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="action_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="system_8h.html">eoslib/system.h</a>&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;   <a class="code" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="code" href="group__actioncapi.html#gaaa8e07b94cea97bd0b6bef4c7cf64422">read_action</a>( <span class="keywordtype">void</span>* msg, <a class="code" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> len );</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;   <a class="code" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="code" href="group__actioncapi.html#gadd0552a97de236e0c7af3ef2dd909c2a">action_size</a>();</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__actioncapi.html#gae232893c733f02b94dbb70fae39d19f7">require_recipient</a>( <a class="code" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> name );</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__actioncapi.html#gab1e668e93ac1f94421743ed79edffb26">require_auth</a>( <a class="code" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> name );</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;   <a class="code" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> <a class="code" href="group__actioncapi.html#ga5fcca014b53b0f15b9f9636325bae976">current_receiver</a>();</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__actioncapi.html#gada68da99a95a5b25e9f5d43af255c63e">send_inline</a>(<span class="keywordtype">char</span> *serialized_action, <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__actioncapi.html#ga9893f539cf6d56989eb6e0d4ce51a813">require_write_lock</a>( <a class="code" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> name );</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="group__actioncapi.html#ga4b02a9d9adf71ae49e77e19fefc0cbf4">require_read_lock</a>( <a class="code" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> name );</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;   <a class="code" href="group__types.html#ga44479e2657d126b44ca53d30c3e670d8">time</a>  <a class="code" href="group__actioncapi.html#ga761ba259bec8bbdab79b31b716a5d4d6">publication_time</a>();</div><div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;   <a class="code" href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a> <a class="code" href="group__actioncapi.html#gaf531fda07a825ca8b0d90f21446e6a64">current_sender</a>();</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;}</div><div class="ttc" id="group__actioncapi_html_ga9893f539cf6d56989eb6e0d4ce51a813"><div class="ttname"><a href="group__actioncapi.html#ga9893f539cf6d56989eb6e0d4ce51a813">require_write_lock</a></div><div class="ttdeci">void require_write_lock(account_name name)</div><div class="ttdoc">Verifies that name exists in the set of write locks held. </div></div>
<div class="ttc" id="group__types_html_ga3b44deb4b3b8d6ebab339d1263692117"><div class="ttname"><a href="group__types.html#ga3b44deb4b3b8d6ebab339d1263692117">account_name</a></div><div class="ttdeci">uint64_t account_name</div><div class="ttdef"><b>Definition:</b> types.h:35</div></div>
<div class="ttc" id="group__actioncapi_html_gadd0552a97de236e0c7af3ef2dd909c2a"><div class="ttname"><a href="group__actioncapi.html#gadd0552a97de236e0c7af3ef2dd909c2a">action_size</a></div><div class="ttdeci">uint32_t action_size()</div><div class="ttdoc">Get the length of current action&amp;#39;s data field. </div></div>
<div class="ttc" id="group__actioncapi_html_ga5fcca014b53b0f15b9f9636325bae976"><div class="ttname"><a href="group__actioncapi.html#ga5fcca014b53b0f15b9f9636325bae976">current_receiver</a></div><div class="ttdeci">account_name current_receiver()</div><div class="ttdoc">Get the account which specifies the code that is being run. </div></div>
<div class="ttc" id="group__types_html_ga44479e2657d126b44ca53d30c3e670d8"><div class="ttname"><a href="group__types.html#ga44479e2657d126b44ca53d30c3e670d8">time</a></div><div class="ttdeci">uint32_t time</div><div class="ttdef"><b>Definition:</b> types.h:39</div></div>
<div class="ttc" id="group__actioncapi_html_gaaa8e07b94cea97bd0b6bef4c7cf64422"><div class="ttname"><a href="group__actioncapi.html#gaaa8e07b94cea97bd0b6bef4c7cf64422">read_action</a></div><div class="ttdeci">uint32_t read_action(void *msg, uint32_t len)</div><div class="ttdoc">Copy current action to the specified location. </div></div>
<div class="ttc" id="group__types_html_ga06896e8c53f721507066c079052171f8"><div class="ttname"><a href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a></div><div class="ttdeci">unsigned long uint32_t</div><div class="ttdef"><b>Definition:</b> types.h:19</div></div>
<div class="ttc" id="group__actioncapi_html_gaf531fda07a825ca8b0d90f21446e6a64"><div class="ttname"><a href="group__actioncapi.html#gaf531fda07a825ca8b0d90f21446e6a64">current_sender</a></div><div class="ttdeci">account_name current_sender()</div><div class="ttdoc">Get the sender of the action. </div></div>
<div class="ttc" id="group__actioncapi_html_gab1e668e93ac1f94421743ed79edffb26"><div class="ttname"><a href="group__actioncapi.html#gab1e668e93ac1f94421743ed79edffb26">require_auth</a></div><div class="ttdeci">void require_auth(account_name name)</div><div class="ttdoc">Verify specified account exists in the set of provided auths. </div></div>
<div class="ttc" id="system_8h_html"><div class="ttname"><a href="system_8h.html">system.h</a></div></div>
<div class="ttc" id="group__actioncapi_html_ga761ba259bec8bbdab79b31b716a5d4d6"><div class="ttname"><a href="group__actioncapi.html#ga761ba259bec8bbdab79b31b716a5d4d6">publication_time</a></div><div class="ttdeci">time publication_time()</div><div class="ttdoc">Get the publication time. </div></div>
<div class="ttc" id="group__actioncapi_html_gae232893c733f02b94dbb70fae39d19f7"><div class="ttname"><a href="group__actioncapi.html#gae232893c733f02b94dbb70fae39d19f7">require_recipient</a></div><div class="ttdeci">void require_recipient(account_name name)</div><div class="ttdoc">Add the specified account to set of accounts to be notified. </div></div>
<div class="ttc" id="group__actioncapi_html_ga4b02a9d9adf71ae49e77e19fefc0cbf4"><div class="ttname"><a href="group__actioncapi.html#ga4b02a9d9adf71ae49e77e19fefc0cbf4">require_read_lock</a></div><div class="ttdeci">void require_read_lock(account_name name)</div><div class="ttdoc">Verifies that name exists in the set of read locks held. </div></div>
<div class="ttc" id="group__actioncapi_html_gada68da99a95a5b25e9f5d43af255c63e"><div class="ttname"><a href="group__actioncapi.html#gada68da99a95a5b25e9f5d43af255c63e">send_inline</a></div><div class="ttdeci">void send_inline(char *serialized_action, size_t size)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
